/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.commons.net.util;

import javax.net.ssl.SSLParameters;
import javax.net.ssl.SSLSocket;

/**
 * General utilities for SSLSocket.
 *
 * @since 3.4
 */
public class SSLSocketUtils {

    /**
     * Enable the HTTPS endpoint identification algorithm on an SSLSocket.
     *
     * @param socket the SSL socket
     * @return Always returns {@code true}
     */
    // TODO for 4.0: becomes a void method.
    public static boolean enableEndpointNameVerification(final SSLSocket socket) {
        final SSLParameters sslParameters = socket.getSSLParameters();
        sslParameters.setEndpointIdentificationAlgorithm("HTTPS");
        socket.setSSLParameters(sslParameters);
        return true;
    }

    private SSLSocketUtils() {
        // Not instantiable
    }
}
